Obtains a pattern ('PAT') resource stored in a resource file.

PatHandle GetPattern (
    SInt16 patternID
);

patternID

The resource ID for a resource of type ëPAT’.

function result

a handle to the pattern having the resource ID that you specify in the patID parameter. If a pattern resource with the ID that you request does not exist, the GetPattern function returns NULL.

DISCUSSION

The GetPattern function calls the following Resource Manager function with these parameters:

GetResource('PAT', patID);

When you are finished using the pattern, dispose of its handle with the Memory Manager function DisposeHandle.

SPECIAL CONSIDERATIONS

The GetPattern function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when InterfaceLib 7.1 or later is installed. Exported by CarbonLib 1.0 and later and by InterfaceLib 7.1 and later.

© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)